home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / time / vclock / vclock.doc < prev    next >
Text File  |  1994-01-12  |  6KB  |  141 lines
  1.  
  2. vclock/vclock                                                 vclock/vclock
  3.  
  4.                 VCLOCK.DOC
  5.  
  6.               A DIGITAL VECTOR CLOCK
  7.  
  8.                 Tobias Ferber
  9.                 Goethestraße 32
  10.                 76135 Karlsruhe
  11.                 Deutschland
  12.  
  13.                 ukjg@ibm3090.rz.uni-karlsruhe.de
  14.  
  15.  
  16.     VCLOCK [options]
  17.  
  18.     VCLOCK a utility like Commodore's Clock.  It opens a sizable window
  19.     showing the current time using 7 segment digits.  It's main purpose
  20.     however is not to come up with an impressing amout of functionality
  21.     but to show you the simple usage of the timer.device and AreaXXXX()
  22.     functions in the graphics.library.
  23.  
  24.     VCLOCK and source is in the PUBLIC DOMAIN.  I claim no copyright at
  25.     all. That means you can do with it whatever you want -- you may even
  26.     sell it (if you can find anyone who would like to pay for it :)
  27.     However donations in any form are not rejected -- preferably post
  28.     cards with a photo of YOUr home-town and the name of the program
  29.     i.e. VCLOCK in this case.
  30.  
  31.                 OPTIONS
  32.  
  33.     VCLOCK supports both AmigaDOS and UNIX style options (with a leading
  34.     minus sign '-').  Options may occur anywhere on the command line but
  35.     they *MUST* occur singly.  I.e.  -a -b instead of -ab.  Options
  36.     requiring a (numeric) value may occur with or without an intervening
  37.     space.  -x17 and -x 17 are both legal.  Last applies to the UNIX
  38.     style options only; AmigaDOS keywords MUST be seperated with one or
  39.     more spaces from their value. The usage of an equals sign '=' instead
  40.     of a space character is NOT legal.  All options must of course be
  41.     seperated with one or more spaces.
  42.  
  43.     VCLOCK options are NOT case-sensitive except for the ToolTypes entries
  44.     which are due to the FindToolType() function in the icon.library.
  45.     This may change in future revisions of this library.  ToolType keywords
  46.     are the same as the AmigaDOS keywords.
  47.  
  48.     Here is a short overview of legal options:
  49.  
  50.     X/N,Y/N,WIDTH/N,HEIGHT/N,SETPEN/N,UNSETPEN/N,OUTLINE/N,BACKFILL/N,
  51.     BORDERLESS/S,BACKDROP/S,NOTITLE/S,NOGADGETS/S,BLANK/N:
  52.  
  53.     X          or '-x'  opening position; left edge (default 0)
  54.     Y          or '-y'                    top edge (default 0)
  55.     WIDTH      or '-w'  initial window size; width (default 350)
  56.     HEIGHT     or '-h'                       height (default 55)
  57.     SETPEN     or '-s'  pen used for set segments (default 2)
  58.     UNSETPEN   or '-u'           for unset segments (default 3)
  59.     OUTLINE    or '-o'           for segment's outline (default 0)
  60.     BACKFILL   or '-b'           to fill the background (default 3)
  61.     BORDERLESS or '-i'  don't render the window border
  62.     BACKDROP   or '-d'  force vclock to be behind all other windows
  63.     NOTITLE    or '-t'  don't display the date in the window title
  64.     NOGADGETS  or '-g'  do not render system gadgets
  65.     BLANK      or '-q'  open screen and show clock w/ given colour table
  66.  
  67.     You can get this list by simply starting VCLOCK with a '?' as argument.
  68.     The trailing /N in AmigaDOS options indicates the need of a [N]umerical
  69.     argument to a keyword.  This parameter is considered a decimal number.
  70.     If an invalid number is specified, an error will be returned.  The '/N'
  71.     must not be typed in command-line with the keyword.
  72.  
  73.  
  74.     -x <xpos>    set the left edge of the VCLOCK window to <xpos>.
  75.         <xpos> therefore must be a numerical argument >= 0.
  76.  
  77.     -y <ypos>    set the top edge of the VCLOCK window to <ypos>.
  78.         <ypos> therefore must be a numerical argument >= 0.
  79.  
  80.         The specified (x|y) position is moved towards (0|0)
  81.         if your width and/or height value would blow up the
  82.         size of the Workbench Screen.
  83.  
  84.     -w <width>    set the width of the VCLOCK window to <width>.
  85.         <width> therefore must be a numerical argument >=0.
  86.  
  87.     -h <height>    set the height of the VCLOCK window to <height>
  88.         <height> therefore must be a numerical argument >=0.
  89.  
  90.         If your width and/or height values were beyond the scope
  91.         of the Workbench Screen size then VCLOCK tries to move
  92.         your window towards the top left corner of the screen.
  93.         Only if they are still too large they are shrunk.
  94.  
  95.     -s <pen>    Specify the pen used for set segments of the lcd digits.
  96.  
  97.         The number of available pens is limited by the depth of
  98.         of your Workbench Screen.  There are 2^n pens available
  99.         if n is the number of bitplans in your Workbench Screen.
  100.  
  101.     -u <pen>    Specify the pen used for unset segments of the lcd digits.
  102.  
  103.     -o <pen>    Set the outline pen of all lcd segments no matter if
  104.         they're set or not.  Set this value to either setpen
  105.         or unsetpen to hide unset segments.
  106.  
  107.     -b <pen>    Set the background colour.  What has been said about pens
  108.         in the description of the '-s' option applies to all pens
  109.         of course.
  110.  
  111.     -i          The intuition WFLG_BORDERLESS will be set for vClock's window.
  112.                 This will result in a window sans border.
  113.  
  114.     -d          vClock's window will open and stay behind all other windows.
  115.  
  116.     -t          No window title will be rendered.  This might be what you're
  117.                 looking for when trying out BORDERLESS and NOGADGETS option.
  118.  
  119.     -g          No system gadgets will be rendered.  In fact the will won't
  120.                 even be a closing gadget.  To quit vClock there now is a
  121.                 Project/Quit menu item.
  122.  
  123.     -q [map]    This option is a by-product of a screen blanker.  It should
  124.         be the only option in the command line.  However it doesn't
  125.         really need to be the only one but all the other options
  126.         will be ignored ;)
  127.  
  128.         In fact this type of "blanker" hasn't been realized since
  129.         the main idea of a screen blanker is to change or turn off
  130.         the display in order to save monitor lifetime.  All this
  131.         does not apply to what you get using the '-t' option. :)
  132.         What you get is a HIRES screen with a centered lcd clock.
  133.         Additionally you may destroy everything that reminds you
  134.         of a blanker by specifying the colour table id [map].
  135.         There are 6 (0..5) built-in colour maps -- try them out.
  136.  
  137.     That's all.  Have fun
  138.  
  139.  
  140.                                   -Tobi
  141.